From bf5a05172118ce64af034d08a1de6a7f819be8dc Mon Sep 17 00:00:00 2001 From: Ewan Mellor Date: Fri, 8 Dec 2006 10:51:41 +0000 Subject: [PATCH] Update doc-comments to match recent documentation tidy-ups. Signed-off-by: Ewan Mellor --- tools/libxen/include/xen_console.h | 4 ++-- tools/libxen/include/xen_host.h | 4 ++-- tools/libxen/include/xen_host_cpu.h | 4 ++-- tools/libxen/include/xen_network.h | 4 ++-- tools/libxen/include/xen_pif.h | 4 ++-- tools/libxen/include/xen_sr.h | 4 ++-- tools/libxen/include/xen_user.h | 4 ++-- tools/libxen/include/xen_vdi.h | 4 ++-- tools/libxen/include/xen_vif.h | 4 ++-- tools/libxen/include/xen_vtpm.h | 4 ++-- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/tools/libxen/include/xen_console.h b/tools/libxen/include/xen_console.h index 450c142637..d8c8f508df 100644 --- a/tools/libxen/include/xen_console.h +++ b/tools/libxen/include/xen_console.h @@ -149,14 +149,14 @@ xen_console_record_opt_set_free(xen_console_record_opt_set *set); /** - * Get the current state of the given console. + * Get a record containing the current state of the given console. */ extern bool xen_console_get_record(xen_session *session, xen_console_record **result, xen_console console); /** - * Get a reference to the object with the specified UUID. + * Get a reference to the console instance with the specified UUID. */ extern bool xen_console_get_by_uuid(xen_session *session, xen_console *result, char *uuid); diff --git a/tools/libxen/include/xen_host.h b/tools/libxen/include/xen_host.h index 2264b603e4..5b1a4dca8a 100644 --- a/tools/libxen/include/xen_host.h +++ b/tools/libxen/include/xen_host.h @@ -154,14 +154,14 @@ xen_host_record_opt_set_free(xen_host_record_opt_set *set); /** - * Get the current state of the given host. !!! + * Get a record containing the current state of the given host. */ extern bool xen_host_get_record(xen_session *session, xen_host_record **result, xen_host host); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the host instance with the specified UUID. */ extern bool xen_host_get_by_uuid(xen_session *session, xen_host *result, char *uuid); diff --git a/tools/libxen/include/xen_host_cpu.h b/tools/libxen/include/xen_host_cpu.h index e0d4ee0c4b..15aee488d4 100644 --- a/tools/libxen/include/xen_host_cpu.h +++ b/tools/libxen/include/xen_host_cpu.h @@ -153,14 +153,14 @@ xen_host_cpu_record_opt_set_free(xen_host_cpu_record_opt_set *set); /** - * Get the current state of the given host_cpu. !!! + * Get a record containing the current state of the given host_cpu. */ extern bool xen_host_cpu_get_record(xen_session *session, xen_host_cpu_record **result, xen_host_cpu host_cpu); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the host_cpu instance with the specified UUID. */ extern bool xen_host_cpu_get_by_uuid(xen_session *session, xen_host_cpu *result, char *uuid); diff --git a/tools/libxen/include/xen_network.h b/tools/libxen/include/xen_network.h index a25babe492..228c7c2ab4 100644 --- a/tools/libxen/include/xen_network.h +++ b/tools/libxen/include/xen_network.h @@ -152,14 +152,14 @@ xen_network_record_opt_set_free(xen_network_record_opt_set *set); /** - * Get the current state of the given network. !!! + * Get a record containing the current state of the given network. */ extern bool xen_network_get_record(xen_session *session, xen_network_record **result, xen_network network); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the network instance with the specified UUID. */ extern bool xen_network_get_by_uuid(xen_session *session, xen_network *result, char *uuid); diff --git a/tools/libxen/include/xen_pif.h b/tools/libxen/include/xen_pif.h index 143ba5709a..edc2b5a83b 100644 --- a/tools/libxen/include/xen_pif.h +++ b/tools/libxen/include/xen_pif.h @@ -155,14 +155,14 @@ xen_pif_record_opt_set_free(xen_pif_record_opt_set *set); /** - * Get the current state of the given PIF. !!! + * Get a record containing the current state of the given PIF. */ extern bool xen_pif_get_record(xen_session *session, xen_pif_record **result, xen_pif pif); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the PIF instance with the specified UUID. */ extern bool xen_pif_get_by_uuid(xen_session *session, xen_pif *result, char *uuid); diff --git a/tools/libxen/include/xen_sr.h b/tools/libxen/include/xen_sr.h index 8359b5737b..eb8a420149 100644 --- a/tools/libxen/include/xen_sr.h +++ b/tools/libxen/include/xen_sr.h @@ -153,14 +153,14 @@ xen_sr_record_opt_set_free(xen_sr_record_opt_set *set); /** - * Get the current state of the given SR. !!! + * Get a record containing the current state of the given SR. */ extern bool xen_sr_get_record(xen_session *session, xen_sr_record **result, xen_sr sr); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the SR instance with the specified UUID. */ extern bool xen_sr_get_by_uuid(xen_session *session, xen_sr *result, char *uuid); diff --git a/tools/libxen/include/xen_user.h b/tools/libxen/include/xen_user.h index b426825585..cce9ba8302 100644 --- a/tools/libxen/include/xen_user.h +++ b/tools/libxen/include/xen_user.h @@ -146,14 +146,14 @@ xen_user_record_opt_set_free(xen_user_record_opt_set *set); /** - * Get the current state of the given user. !!! + * Get a record containing the current state of the given user. */ extern bool xen_user_get_record(xen_session *session, xen_user_record **result, xen_user user); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the user instance with the specified UUID. */ extern bool xen_user_get_by_uuid(xen_session *session, xen_user *result, char *uuid); diff --git a/tools/libxen/include/xen_vdi.h b/tools/libxen/include/xen_vdi.h index ba20f755c6..cfdbc6a61c 100644 --- a/tools/libxen/include/xen_vdi.h +++ b/tools/libxen/include/xen_vdi.h @@ -159,14 +159,14 @@ xen_vdi_record_opt_set_free(xen_vdi_record_opt_set *set); /** - * Get the current state of the given VDI. !!! + * Get a record containing the current state of the given VDI. */ extern bool xen_vdi_get_record(xen_session *session, xen_vdi_record **result, xen_vdi vdi); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the VDI instance with the specified UUID. */ extern bool xen_vdi_get_by_uuid(xen_session *session, xen_vdi *result, char *uuid); diff --git a/tools/libxen/include/xen_vif.h b/tools/libxen/include/xen_vif.h index 8930a7849f..4efc3f0851 100644 --- a/tools/libxen/include/xen_vif.h +++ b/tools/libxen/include/xen_vif.h @@ -156,14 +156,14 @@ xen_vif_record_opt_set_free(xen_vif_record_opt_set *set); /** - * Get the current state of the given VIF. !!! + * Get a record containing the current state of the given VIF. */ extern bool xen_vif_get_record(xen_session *session, xen_vif_record **result, xen_vif vif); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the VIF instance with the specified UUID. */ extern bool xen_vif_get_by_uuid(xen_session *session, xen_vif *result, char *uuid); diff --git a/tools/libxen/include/xen_vtpm.h b/tools/libxen/include/xen_vtpm.h index f55d74217b..a04c8d4de3 100644 --- a/tools/libxen/include/xen_vtpm.h +++ b/tools/libxen/include/xen_vtpm.h @@ -151,14 +151,14 @@ xen_vtpm_record_opt_set_free(xen_vtpm_record_opt_set *set); /** - * Get the current state of the given VTPM. !!! + * Get a record containing the current state of the given VTPM. */ extern bool xen_vtpm_get_record(xen_session *session, xen_vtpm_record **result, xen_vtpm vtpm); /** - * Get a reference to the object with the specified UUID. !!! + * Get a reference to the VTPM instance with the specified UUID. */ extern bool xen_vtpm_get_by_uuid(xen_session *session, xen_vtpm *result, char *uuid); -- 2.30.2